docs(dual-region): add operational procedure #3473
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Langleu
added
the
component:self-managed
|
👋 🤖 🤔 Hello! Did you make your changes in all the right places? These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.4/.
You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
maxdanilov
reviewed
Mar 13, 2024
There was a problem hiding this comment.
No deep review yet, but I really like the approach and structure, especially the before-after comparison and steps explanation.
Some small suggestions:
- for the pictures, add the namespace and cluster visualization (i.e. that in region 1 there's cluster 1 inside which there's camunda_1 and camunda_1_failover namespace etc)
- switch from 1/2 numbering to 0/1 as in the EKS guide
Would also be good to add a legend to the terms used in the illustrations (e.g. ES = Elasticsearch), what's the difference between gray and black lines for Exporter 1/2 connections.
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
Outdated
Show resolved
Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
Outdated
Show resolved
Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
Outdated
Show resolved
Hide resolved
maxdanilov
reviewed
Mar 13, 2024
docs/self-managed/operational-guides/multi-region/components/stateContainer.jsx
Outdated
Show resolved
Hide resolved
docs/self-managed/operational-guides/multi-region/components/stateContainer.jsx
Outdated
Show resolved
Hide resolved
|
@Langleu Will this go out with release next week? |
|
@christinaausley , that's the plan at least. This and everything that was already reviewed and merged into |
9 tasks
maxdanilov
requested changes
Apr 2, 2024
There was a problem hiding this comment.
Looks good overall, great job 👏
Aside from the wording / capitalization, 3 things from my side:
- terminology/naming
- I suggest we consistently use terms
surviving region,lost region,recreated region(or similar) in the doc (and avoid REGION0/1 if possible, at least in the texts)
- I suggest we consistently use terms
- I've seen
Camunda Platformused multiple times across the doc, but I think we've phased it out in favor of justCamunda 8(marketing) and also it's not always clear when it means "Zeebe + WebApps" and when just "WebApps" - I think introducing new env vars for the value of the surviving / lost / recreated regions (instead of basing the commands on REGION 0 and telling the customer to adjust when needed) will make the approach simpler and more robust for the users
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
Outdated
Show resolved
Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
Outdated
Show resolved
Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
Outdated
Show resolved
Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
Outdated
Show resolved
Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
Outdated
Show resolved
Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
Outdated
Show resolved
Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
Outdated
Show resolved
Hide resolved
|
@maxdanilov , thanks for the review! About 1) agree, i tried checking the region mentionings and adjusted to the 3 chosen identifiers. |
including changes in wording and capitalization
maxdanilov
approved these changes
Apr 3, 2024
There was a problem hiding this comment.
LGTM, thank you for addressing the comments. Leaving minor improvement suggestions, but nothing requiring a re-review from me later.
I'll later go through the whole procedure E2E so may be some feedback from that, but that'd probably be more on the technical details (e.g. if some commands have issues etc.)
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
Outdated
Show resolved
Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
Outdated
Show resolved
Hide resolved
Langleu
changed the title
|
@christinaausley We are ready for a final technical writer review 🚀 |
maxdanilov
approved these changes
Apr 3, 2024
|
@Langleu We can merge this in as I'll have one final look over |
Langleu
added a commit
that referenced
this pull request
Apr 4, 2024
* docs(dual-region): add operational procedure * docs(dual-region): first rework of the operational procedure * docs(multi-region): describe all steps for operational guide * docs(dual-region): adjust viewbox and add more verification steps * docs(dual-region): apply prettier suggestion * docs(dual-region): move helm chart release and version to env var * docs(dual-region): adjust missing links by resolving todos * docs(dual-region): add remaining verifcation steps * docs(dual-region): add info admonition on elasticsearch backup source * docs(dual-region): address review feedback first batch including changes in wording and capitalization * docs(dual-region): change use of environment variables * docs(dual-region): align disclaimer with concept page * docs(dual-region): add termonology and tabs for env preqs
Langleu
added a commit
that referenced
this pull request
Apr 5, 2024
* docs(dual-region): add operational procedure * docs(dual-region): first rework of the operational procedure * docs(multi-region): describe all steps for operational guide * docs(dual-region): adjust viewbox and add more verification steps * docs(dual-region): apply prettier suggestion * docs(dual-region): move helm chart release and version to env var * docs(dual-region): adjust missing links by resolving todos * docs(dual-region): add remaining verifcation steps * docs(dual-region): add info admonition on elasticsearch backup source * docs(dual-region): address review feedback first batch including changes in wording and capitalization * docs(dual-region): change use of environment variables * docs(dual-region): align disclaimer with concept page * docs(dual-region): add termonology and tabs for env preqs
Langleu
added a commit
that referenced
this pull request
Apr 5, 2024
* docs(aws): dual-region setup in AWS (#3430) * docs(aws): add dual-region setup * docs(aws): additions to the dual-region setup * docs(aws): switch to tabs and collapsables for dual-region * docs(aws): further adjustments to the dual-region * style(formatting): initial technical review * docs(aws): pull request adjustments pre-cloning setup * docs(aws): dual-region switch to git clone * docs(aws): pull request adjustments * docs(aws): remove tabs and simplify with more scripts * docs(aws): use new folder path * docs(aws): implement pr suggestions * small tweak --------- Co-authored-by: Christina Ausley <[email protected]> * chore(aws): add multi-region concept page (#3519) * docs(dual-region): add concept page * chore(aws): add concept page * chore(aws): dual-region, add region loss info * docs(dual-region): implement PR suggestions for concept page * docs(dual-region): add look at region loss for concept page * docs(dual-region): small restructure * docs(dual-region): add missing info on sizing and lost data * docs(dual-region): more concept page adjustments * style(formatting): technical review --------- Co-authored-by: Christina Ausley <[email protected]> * docs(dual-region): add disaster recovery RPO and RTO * docs(dual-regeion): address review feedback of concept page * docs(dual-region): add operational procedure (#3473) * docs(dual-region): add operational procedure * docs(dual-region): first rework of the operational procedure * docs(multi-region): describe all steps for operational guide * docs(dual-region): adjust viewbox and add more verification steps * docs(dual-region): apply prettier suggestion * docs(dual-region): move helm chart release and version to env var * docs(dual-region): adjust missing links by resolving todos * docs(dual-region): add remaining verifcation steps * docs(dual-region): add info admonition on elasticsearch backup source * docs(dual-region): address review feedback first batch including changes in wording and capitalization * docs(dual-region): change use of environment variables * docs(dual-region): align disclaimer with concept page * docs(dual-region): add termonology and tabs for env preqs * docs(dual-region): added simplifcations and more verifications * docs(dual-region): fix typo in verification * docs(dual-region): fix todo linkage * style(formatting): technical review * docs(dual-region): minor kubectl refinements added of image source --------- Co-authored-by: Christina Ausley <[email protected]>
theburi
pushed a commit
that referenced
this pull request
Jun 5, 2024
* docs(aws): dual-region setup in AWS (#3430) * docs(aws): add dual-region setup * docs(aws): additions to the dual-region setup * docs(aws): switch to tabs and collapsables for dual-region * docs(aws): further adjustments to the dual-region * style(formatting): initial technical review * docs(aws): pull request adjustments pre-cloning setup * docs(aws): dual-region switch to git clone * docs(aws): pull request adjustments * docs(aws): remove tabs and simplify with more scripts * docs(aws): use new folder path * docs(aws): implement pr suggestions * small tweak --------- Co-authored-by: Christina Ausley <[email protected]> * chore(aws): add multi-region concept page (#3519) * docs(dual-region): add concept page * chore(aws): add concept page * chore(aws): dual-region, add region loss info * docs(dual-region): implement PR suggestions for concept page * docs(dual-region): add look at region loss for concept page * docs(dual-region): small restructure * docs(dual-region): add missing info on sizing and lost data * docs(dual-region): more concept page adjustments * style(formatting): technical review --------- Co-authored-by: Christina Ausley <[email protected]> * docs(dual-region): add disaster recovery RPO and RTO * docs(dual-regeion): address review feedback of concept page * docs(dual-region): add operational procedure (#3473) * docs(dual-region): add operational procedure * docs(dual-region): first rework of the operational procedure * docs(multi-region): describe all steps for operational guide * docs(dual-region): adjust viewbox and add more verification steps * docs(dual-region): apply prettier suggestion * docs(dual-region): move helm chart release and version to env var * docs(dual-region): adjust missing links by resolving todos * docs(dual-region): add remaining verifcation steps * docs(dual-region): add info admonition on elasticsearch backup source * docs(dual-region): address review feedback first batch including changes in wording and capitalization * docs(dual-region): change use of environment variables * docs(dual-region): align disclaimer with concept page * docs(dual-region): add termonology and tabs for env preqs * docs(dual-region): added simplifcations and more verifications * docs(dual-region): fix typo in verification * docs(dual-region): fix todo linkage * style(formatting): technical review * docs(dual-region): minor kubectl refinements added of image source --------- Co-authored-by: Christina Ausley <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Introduced the guide around the operational procedure for recovering your dual-region setup temporarily and permanently in case of a lost region.
When should this change go live?
holdlabel or convert to draft PR)?PR Checklist
/versioned_docsdirectory, or they are not for an already released version./docsdirectory (aka/next/), or they are not for future versions.